<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeVFSContext</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
<link rel="up" href="modules.html" title="Filesystem Modules">
<link rel="prev" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html" title="gnome-vfs-module-callback-module-api">
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-transform.html" title="gnome-vfs-transform">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="modules.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
<td><a accesskey="n" href="gnome-vfs-2.0-gnome-vfs-transform.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gnome-vfs-2.0-gnome-vfs-context.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gnome-vfs-2.0-gnome-vfs-context.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gnome-vfs-2.0-gnome-vfs-context"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-context.top_of_page"></a>GnomeVFSContext</span></h2>
<p>GnomeVFSContext — contexts allows modules to track thread usage and cancellation properly</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gnome-vfs-2.0-gnome-vfs-context.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="returnvalue">GnomeVFSContext</span></a> *   <a class="link" href="gnome-vfs-2.0-gnome-vfs-context.html#gnome-vfs-context-new" title="gnome_vfs_context_new ()">gnome_vfs_context_new</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gnome-vfs-2.0-gnome-vfs-context.html#gnome-vfs-context-free" title="gnome_vfs_context_free ()">gnome_vfs_context_free</a>              (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *ctx</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSCancellation" title="GnomeVFSCancellation"><span class="returnvalue">GnomeVFSCancellation</span></a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-context.html#gnome-vfs-context-get-cancellation" title="gnome_vfs_context_get_cancellation ()">gnome_vfs_context_get_cancellation</a>
                                                        (<em class="parameter"><code>const <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *ctx</code></em>);
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-context.html#gnome-vfs-context-check-cancellation" title="gnome_vfs_context_check_cancellation()">gnome_vfs_context_check_cancellation</a>(x)
const <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="returnvalue">GnomeVFSContext</span></a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-context.html#gnome-vfs-context-peek-current" title="gnome_vfs_context_peek_current ()">gnome_vfs_context_peek_current</a>  (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="gnome-vfs-2.0-gnome-vfs-context.html#gnome-vfs-context-check-cancellation-current" title="gnome_vfs_context_check_cancellation_current ()">gnome_vfs_context_check_cancellation_current</a>
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-context.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-context.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gnome-vfs-context-new"></a><h3>gnome_vfs_context_new ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="returnvalue">GnomeVFSContext</span></a> *   gnome_vfs_context_new               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new context and cancellation object. Must be called
from the main glib event loop.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-context-free"></a><h3>gnome_vfs_context_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_vfs_context_free              (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *ctx</code></em>);</pre>
<p>
Free <em class="parameter"><code>ctx</code></em> and destroy the associated <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSCancellation" title="GnomeVFSCancellation"><span class="type">GnomeVFSCancellation</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td>
<td>context to be freed.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-context-get-cancellation"></a><h3>gnome_vfs_context_get_cancellation ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSCancellation" title="GnomeVFSCancellation"><span class="returnvalue">GnomeVFSCancellation</span></a> * gnome_vfs_context_get_cancellation
                                                        (<em class="parameter"><code>const <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *ctx</code></em>);</pre>
<p>
Retrieve the <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSCancellation" title="GnomeVFSCancellation"><span class="type">GnomeVFSCancellation</span></a> associated with <em class="parameter"><code>ctx</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td>
<td>context to get the <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSCancellation" title="GnomeVFSCancellation"><span class="type">GnomeVFSCancellation</span></a> from.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <em class="parameter"><code>ctx</code></em> 's <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSCancellation" title="GnomeVFSCancellation"><span class="type">GnomeVFSCancellation</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-context-check-cancellation"></a><h3>gnome_vfs_context_check_cancellation()</h3>
<pre class="programlisting">#define             gnome_vfs_context_check_cancellation(x)</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-context-peek-current"></a><h3>gnome_vfs_context_peek_current ()</h3>
<pre class="programlisting">const <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="returnvalue">GnomeVFSContext</span></a> * gnome_vfs_context_peek_current  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the currently active context. It shouldn't be
manipulated but can be compared to contexts module
holds to determine whether they are active.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the currently active <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-context-check-cancellation-current"></a><h3>gnome_vfs_context_check_cancellation_current ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gnome_vfs_context_check_cancellation_current
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Check to see if the currently active context has been cancelled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the currently active context has been cancelled, otherwise <code class="literal">FALSE</code>.
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>